Replaced 'Github' with 'GitHub' in tech-work-experience.md #7589
Conversation
|
Want to review this pull request? Take a look at this documentation for a step by step guide! From your project repository, check out a new branch and test the changes. |
github-actions
bot
added
role: front end
|
ETA: EOD Oct 16 |
There was a problem hiding this comment.
Hi @pluto-bell,
Thank you for taking the time to work on this issue!
Things that went well:
- The issue was correctly linked.
- The right file was modified.
- You applied the necessary labels.
- Including the before-and-after screenshots was very helpful, making it easy for others to review the changes.
Areas for improvement:
- The branch name could be updated. There's no need to include "pluto" twice. A better option would be
replace_Github_with_GitHub-7414.
Please feel free to reach out if you have any questions or need further clarification. Thanks again for your valuable contribution!
|
@codyyjxn thanks for your review! The branch name may be a little redundant but there is no way to change it without closing this pull request and opening a new one, and the guidelines about branch names are more suggestions than hard and fast rules. If everything else looks good let's approve this PR as is and @pluto-bell can keep your feedback in mind for future issues. @k-cardon please leave a comment with your availability and ETA if you are still planning to review this issue. |
|
ETA: EOD Oct 17 |
|
@codyyjxn I see, I didn't realize it was configured to automatically add my user name, on my end the branch was just: Now I know it'll be taken care of for me (:, thanks for the point out. |
No Problem. Please request a review so I can approve this tonight. |
There was a problem hiding this comment.
Hi @pluto-bell,
Great job on this issue! Tracking down the right files in this project can be difficult but you found the right files that use this variable. I tested your changed locally and it looks good! Both the project card in the projects page and the project specific page now display GitHub.
Things you did well:
- PR title is informative and concise
- comment includes "Fixes..."
- What section is answered well
- Screenshots clearly show the change
- You correctly identified the connected files
- You changed only the appropriate line of code
What could be improved:
- Why section: the why section is not entirely accurate. This change isn't due to display issues, rather it's to unify the presentation of the name "GitHub" across the website. We don't want to display "Github" which is not how the company spells their name.
- File name mentions: it would be nice to have full path
assets/js/current-projects.jsinstead ofcurrent-projects.js. This is not a big deal, but we have many directories and it can be hard to find files so having the full path makes things easier. - The branch naming has already been addressed. However, a small clarification is necessary. Your name is not being added to the branch, your GitHub handle is being displayed as the source of the branch. For example, it says "commit into hackforla:gh-pages" to inform us that the commit will be merged into gh-pages which belongs to the "hackforla" organization's GitHub handle.
|
I would like to mention something which Bonnie mentioned at yesterday's (Oct 15) dev meeting. When someone doesn't name the branch correctly, we don't need to have them rename the branch and make a new PR. We can leave feedback and they can do better next time. It looks like you too are already on board with this idea, but I thought I would mention it just to be safe. @pluto-bell, I already re-requested a review form @codyyjxn. However, I think the old "requested changes" needs to be dismissed. I could do it for you, but I thought it best to leave it to you. |
Fixes #7414
What changes did you make?
- name: Githubwith- name: GitHubin_projects/tech-work-experience.mdWhy did you make the changes (we will use this info to test)?
name:variableScreenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)
Visuals before changes are applied
Visuals after changes are applied
Connected Files
The
_projects/tech-work-experience.mdis referenced by_layouts/project.htmlwhich dynamically creates each project card.The
_projects/tech-work-experience.mdfile is also referenced bycurrent-projects.jswhich dynamically creates a display card for each project.Test Procedure
Follow How to review Pull Requests in order to clone the feature branch
Compare the Tech Work Experience card between http://localhost:4000/projects and https://www.hackforla.org/projects/. More specifically, compare the link elements.
Similarly, compare the Tech Work Experience card between http://localhost:4000/projects/tech-work-experience and https://www.hackforla.org/projects/tech-work-experience. More specifically, compare the link elements.